home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet multimedia / Animacje, filmy i prezentacje / Modelowanie 3D / K-3D 0.6.5.0 / k3d-all-in-one-setup-0.6.5.0.exe / aqsis-setup-1.1.0-2006-12-09.exe / include / aqsis / file.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-06-14  |  4.2 KB  |  146 lines
  1. // Aqsis
  2. // Copyright ⌐ 1997 - 2001, Paul C. Gregory
  3. //
  4. // Contact: pgregory@aqsis.org
  5. //
  6. // This library is free software; you can redistribute it and/or
  7. // modify it under the terms of the GNU General Public
  8. // License as published by the Free Software Foundation; either
  9. // version 2 of the License, or (at your option) any later version.
  10. //
  11. // This library is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14. // General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU General Public
  17. // License along with this library; if not, write to the Free Software
  18. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  
  20.  
  21. /** \file
  22.         \brief Declares the CqFile class for handling files with RenderMan searchpath option support.
  23.         \author Paul C. Gregory (pgregory@aqsis.org)
  24. */
  25.  
  26. //? Is .h included already?
  27. #ifndef FILE_H_INCLUDED
  28. #define FILE_H_INCLUDED 1
  29.  
  30. #include    <iostream>
  31. #include    <list>
  32.  
  33. #include    "aqsis.h"
  34.  
  35. #include    "sstring.h"
  36.  
  37. START_NAMESPACE( Aqsis )
  38.  
  39. // This should'nt really be in here, but for now it will do
  40. #ifdef AQSIS_SYSTEM_WIN32
  41. #define DIRSEP "\\"
  42. #else
  43. #define DIRSEP "/"
  44. #endif
  45.  
  46. //----------------------------------------------------------------------
  47. /** \class CqFile
  48.  *  \brief Standard handling of all file types utilising the searchpath options.
  49.  */
  50. class CqFile
  51. {
  52.     public:
  53.         /** Default constructor
  54.          */
  55.         CqFile() : m_pStream( 0 ), m_bInternal( TqFalse )
  56.         {}
  57.         /** Constructor taking an open stream pointer and a name.
  58.          * \param Stream a pointer to an already opened input stream to attach this object to.
  59.          * \param strRealName the name of the file associated with this stream.
  60.          */
  61.         CqFile( std::istream* Stream, const char* strRealName ) :
  62.                 m_pStream( Stream ), m_strRealName( strRealName ), m_bInternal( TqFalse )
  63.         {}
  64.         CqFile( const char* strFilename, const char* strSearchPathOption = "" );
  65.         /** Dectructor. Takes care of closing the stream if the constructor opened it.
  66.          */
  67.         virtual    ~CqFile()
  68.         {
  69.             if ( m_pStream != NULL && m_bInternal )
  70.                 delete( m_pStream );
  71.         }
  72.  
  73.         void    Open( const char* strFilename, const char* strSearchPathOption = "", std::ios::openmode mode = std::ios::in );
  74.         /** Close any opened stream associated with this object.
  75.          */
  76.         void    Close()
  77.         {
  78.             if ( m_pStream != NULL )
  79.                 delete( m_pStream );
  80.             m_pStream = NULL;
  81.         }
  82.         /** Find out if the stream associated with this object is valid.
  83.          * \return boolean indicating validity.
  84.          */
  85.         TqBool    IsValid() const
  86.         {
  87.             return ( m_pStream != NULL );
  88.         }
  89.         /** Get the name asociated with this file object.
  90.          * \return a read only reference to the string object.
  91.          */
  92.         const CqString&    strRealName() const
  93.         {
  94.             return ( m_strRealName );
  95.         }
  96.  
  97.         /** Cast to a stream reference.
  98.          */
  99.         operator std::istream&()
  100.         {
  101.             return ( *m_pStream );
  102.         }
  103.         /** Cast to a stream pointer.
  104.          */
  105.         operator std::istream*()
  106.         {
  107.             return ( m_pStream );
  108.         }
  109.  
  110.         /** Get the current position within the stream if appropriate.
  111.          * \return long integer indicating the offest from the start.
  112.          */
  113.         TqLong    Position()
  114.         {
  115.             return ( m_pStream->tellg() );
  116.         }
  117.         /** Get the length of the stream if a file.
  118.          * \return the lenght as a long integer.
  119.          */
  120.         TqLong    Length()
  121.         {
  122.             /// \todo Should check if it is a file here.
  123.             long pos = Position();
  124.             m_pStream->seekg( 0, std::ios::end );
  125.             long len = Position();
  126.             m_pStream->seekg( pos, std::ios::beg );
  127.             return ( len );
  128.         }
  129.  
  130.         CqString FixupPath(CqString& strPath);
  131.  
  132.         static std::list<CqString*> Glob( const CqString& strFileGlob );
  133.  
  134.     private:
  135.         std::istream*    m_pStream;        ///< a poimter to the stream associated with this file object.
  136.         CqString    m_strRealName;    ///< the name of this file object, usually the filename.
  137.         TqBool    m_bInternal;    ///< a flag indicating whether the stream originated internally, or was externally created and passed in.
  138. }
  139. ;
  140.  
  141. //-----------------------------------------------------------------------
  142.  
  143. END_NAMESPACE( Aqsis )
  144.  
  145. #endif    // !FILE_H_INCLUDED
  146.